revelplayer/com.reveldigital.player.api/[androidJvm]Module

Module

interface Module

Represents a distinct region or zone within a digital signage screen layout or template.

A Module defines an area on the screen where content, such as media from a Playlist or a specific application type (e.g., a weather display, a web view), is rendered. Modules have defined positions, dimensions, and a stacking order (z-order) to manage how they appear relative to each other.

Each module can be configured with specific Options that modify its behavior or appearance. They are typically defined as part of a screen template or layout within the RevelDigital content management system.

See also

// Ensure Playlist interface/class is well-documented

// Ensure Option interface/class is well-documented

Functions

abstract fun getHeight(): Int

Gets the height of the module.

abstract fun getId(): String

Gets the unique identifier for this module.

abstract fun getLeft(): Int

Gets the horizontal offset (x-coordinate) of the module's top-left corner from the left edge of the screen or parent container.

abstract fun getName(): String

Gets the user-defined name of the module.

abstract fun getOptions(): Iterator<out Option>

Gets an iterator over the configuration options defined for this module.

abstract fun getPlaylist(): Playlist

Gets the Playlist assigned to this module, which defines the sequence of media items to be played within this module's boundaries.

abstract fun getSequence(): Int

Gets the z-order (stacking order) sequence of the module.

abstract fun getTop(): Int

Gets the vertical offset (y-coordinate) of the module's top-left corner from the top edge of the screen or parent container.

abstract fun getType(): String

Gets the type of the module, indicating its intended content or functionality.

abstract fun getWidth(): Int

Gets the width of the module.